Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Sphinx API documentation framework #11

Merged
merged 15 commits into from
Oct 28, 2024
Merged

Sphinx API documentation framework #11

merged 15 commits into from
Oct 28, 2024

Conversation

dreamer2368
Copy link
Collaborator

@dreamer2368 dreamer2368 commented Oct 17, 2024 •
edited
Loading

API reference webpage is automatically built using Sphinx. References used for this PR are:

API website workflow is:

  • The website will be built (not deployed) for every commit of a PR to main branch. This will check if all the comments in the source directory are written in a proper way.
  • Upon the PR's merging into main branch, the website will be deployed public to software.llnl.gov/GPLaSDI/

For documenting style, we will follow the numpy style:
https://www.sphinx-doc.org/en/master/usage/extensions/example_numpy.html

src/lasdi/timing.py shows the example comment according to the numpy style, which is parsed into the API webpage for timing.py.

@dreamer2368 dreamer2368 force-pushed the sphinx branch 7 times, most recently from 4f53499 to 6a4851d Compare October 17, 2024 17:16
@dreamer2368 dreamer2368 marked this pull request as ready for review October 17, 2024 17:39
@dreamer2368 dreamer2368 added the RFR Ready for Review label Oct 17, 2024
@dreamer2368 dreamer2368 changed the title Sphinx Sphinx API documentation framework Oct 17, 2024
@CBonneville45
Copy link
Collaborator

API Doc looks great!
Minor note: On the Sphinx API page, I'd suggest adding our LaSDI review paper among the references (https://arxiv.org/abs/2403.10748). Since it's essentially a unified summary of all (currently existing) LaSDI building blocks (as of March 2024), it would be a helpful ressource for prospective users of the library

@dreamer2368
Copy link
Collaborator Author

API Doc looks great! Minor note: On the Sphinx API page, I'd suggest adding our LaSDI review paper among the references (https://arxiv.org/abs/2403.10748). Since it's essentially a unified summary of all (currently existing) LaSDI building blocks (as of March 2024), it would be a helpful ressource for prospective users of the library

This is added now.

This was referenced Oct 24, 2024
Merged
Open
punkduckable
punkduckable approved these changes Oct 28, 2024
View reviewed changes
Copy link
Collaborator

@punkduckable punkduckable left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Everything looks good to me.

@dreamer2368 dreamer2368 merged commit 32f1944 into main Oct 28, 2024
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@punkduckable punkduckable punkduckable approved these changes

@chldkdtn chldkdtn Awaiting requested review from chldkdtn

@CBonneville45 CBonneville45 Awaiting requested review from CBonneville45

@andersonw1 andersonw1 Awaiting requested review from andersonw1

Assignees
No one assigned
Labels
RFR Ready for Review
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@dreamer2368 @CBonneville45 @punkduckable